# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.PageSpeedOnline.V4.Api.Pagespeedapi do
  @moduledoc """
  API calls for all endpoints tagged `Pagespeedapi`.
  """

  alias GoogleApi.PageSpeedOnline.V4.Connection
  alias GoogleApi.Gax.{Request, Response}

  @library_version Mix.Project.config() |> Keyword.get(:version, "")

  @doc """
  Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information.

  ## Parameters

  *   `connection` (*type:* `GoogleApi.PageSpeedOnline.V4.Connection.t`) - Connection to server
  *   `url` (*type:* `String.t`) - The URL to fetch and analyze
  *   `optional_params` (*type:* `keyword()`) - Optional parameters
      *   `:alt` (*type:* `String.t`) - Data format for the response.
      *   `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
      *   `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
      *   `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
      *   `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
      *   `:quotaUser` (*type:* `String.t`) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
      *   `:userIp` (*type:* `String.t`) - Deprecated. Please use quotaUser instead.
      *   `:filter_third_party_resources` (*type:* `boolean()`) - Indicates if third party resources should be filtered out before PageSpeed analysis.
      *   `:locale` (*type:* `String.t`) - The locale used to localize formatted results
      *   `:rule` (*type:* `list(String.t)`) - A PageSpeed rule to run; if none are given, all rules are run
      *   `:screenshot` (*type:* `boolean()`) - Indicates if binary data containing a screenshot should be included
      *   `:snapshots` (*type:* `boolean()`) - Indicates if binary data containing snapshot images should be included
      *   `:strategy` (*type:* `String.t`) - The analysis strategy (desktop or mobile) to use, and desktop is the default
      *   `:utm_campaign` (*type:* `String.t`) - Campaign name for analytics.
      *   `:utm_source` (*type:* `String.t`) - Campaign source for analytics.
  *   `opts` (*type:* `keyword()`) - Call options

  ## Returns

  *   `{:ok, %GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4{}}` on success
  *   `{:error, info}` on failure
  """
  @spec pagespeedonline_pagespeedapi_runpagespeed(
          Tesla.Env.client(),
          String.t(),
          keyword(),
          keyword()
        ) ::
          {:ok, GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4.t()}
          | {:ok, Tesla.Env.t()}
          | {:error, any()}
  def pagespeedonline_pagespeedapi_runpagespeed(
        connection,
        url,
        optional_params \\ [],
        opts \\ []
      ) do
    optional_params_config = %{
      :alt => :query,
      :fields => :query,
      :key => :query,
      :oauth_token => :query,
      :prettyPrint => :query,
      :quotaUser => :query,
      :userIp => :query,
      :filter_third_party_resources => :query,
      :locale => :query,
      :rule => :query,
      :screenshot => :query,
      :snapshots => :query,
      :strategy => :query,
      :utm_campaign => :query,
      :utm_source => :query
    }

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/runPagespeed", %{})
      |> Request.add_param(:query, :url, url)
      |> Request.add_optional_params(optional_params_config, optional_params)
      |> Request.library_version(@library_version)

    connection
    |> Connection.execute(request)
    |> Response.decode(
      opts ++ [struct: %GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4{}]
    )
  end
end
